EstuaryClient.AdminApi

All URIs are relative to https://api.estuary.tech

Method	HTTP request	Description
adminPeeringPeersDelete	DELETE /admin/peering/peers	Remove peers on Peering Service
adminPeeringPeersGet	GET /admin/peering/peers	List all Peering peers
adminPeeringPeersPost	POST /admin/peering/peers	Add peers on Peering Service
adminPeeringStartPost	POST /admin/peering/start	Start Peering
adminPeeringStatusGet	GET /admin/peering/status	Check Peering Status
adminPeeringStopPost	POST /admin/peering/stop	Stop Peering
adminSystemConfigGet	GET /admin/system/config	Get systems(estuary/shuttle) config
adminUsersGet	GET /admin/users	Get all users

# **adminPeeringPeersDelete** > adminPeeringPeersDelete(body)

Remove peers on Peering Service

This endpoint can be used to remove a Peer from the Peering Service

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var body = [new EstuaryClient.[String]()]; // [String] | Peer ids


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringPeersDelete(body, callback);

Parameters

Name	Type	Description	Notes
body	[String]	Peer ids

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminPeeringPeersGet** > adminPeeringPeersGet()

List all Peering peers

This endpoint can be used to list all peers on Peering Service

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringPeersGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminPeeringPeersPost** > adminPeeringPeersPost()

Add peers on Peering Service

This endpoint can be used to add a Peer from the Peering Service

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringPeersPost(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminPeeringStartPost** > adminPeeringStartPost()

Start Peering

This endpoint can be used to start the Peering Service

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringStartPost(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminPeeringStatusGet** > adminPeeringStatusGet()

Check Peering Status

This endpoint can be used to check the Peering status

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringStatusGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminPeeringStopPost** > adminPeeringStopPost()

Stop Peering

This endpoint can be used to stop the Peering Service

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminPeeringStopPost(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminSystemConfigGet** > adminSystemConfigGet()

Get systems(estuary/shuttle) config

This endpoint is used to get system configs.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminSystemConfigGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminUsersGet** > adminUsersGet()

Get all users

This endpoint is used to get all users.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AdminApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminUsersGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json